package org.xliu.cs.projects.anno_for_doc.generate;

import java.io.IOException;
import java.util.Set;

public interface Generator {

    /**
     * 扫描包下的类文件（不支持 jar），根据注解生成 markdown，保证 code / doc 一致性。
     *
     * @param pkgPrefix   : 包前缀，如 "org.xliu.cs.algs_ds"
     * @param outFilePath : 输出文件名，如 "README.md"
     * @param skipPkgs    : 忽略的包名，如 "org/xliu/cs/algs_ds/ignore_package"
     */
    void generate(String pkgPrefix, String outFilePath, Set<String> skipPkgs) throws IOException;

}
